﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////

// Reviewed
#pragma once
#include "IDbObject.h"
#include "GcmpModelInterface.h"
#include "RegenDataId.h"


namespace gcmp
{
    class IGraphicsElementShape;
    class IElement;
    /// \brief 打洞图形显示组件
    FINAL_INTERFACE class GCMP_MODEL_INTERFACE_EXPORT IOpeningGraphicsElementShapeComponent : public IDbObject
    {
        DEFINE_CAST_DERIVED(gcmp::IOpeningGraphicsElementShapeComponent, gcmp::IDbObject);
    public:
        /// \brief 用于获取打洞图形显示数据。
        /// 
        /// 如果族中包含扣减体，其实例会包含扣减图形显示数据，用来对其他实例的图形显示数据做扣减或打洞。
        /// \return 打洞图形显示数据的指针。
        virtual const IGraphicsElementShape* GetOpeningGraphicsElementShape() const = 0;

        /// \brief 设置打洞图形显示数据
        /// \param upGraphicsElementShape 新的图形显示数据指针。
        /// \return void
        virtual void SetOpeningGraphicsElementShape(OwnerPtr<IGraphicsElementShape> upGraphicsElementShape) = 0;

        /// \brief 用于获取执行连接操作后的打洞图形显示数据。
        /// 
        /// \return 执行连接操作后的打洞图形显示数据的指针。
        virtual const IGraphicsElementShape* GetJoinedCutterGraphicsElementShape() const = 0;

        /// \brief 设置执行连接操作后的打洞图形显示数据
        /// \param opCutterGrep 执行连接操作后的打洞图形显示数据指针。
        /// \return void
        virtual void SetJoinedCutterGraphicsElementShape(OwnerPtr<IGraphicsElementShape> opCutterGrep) = 0;

        /// \brief 获得Element打洞图形表达关联更新变化Id
        /// \return Element打洞图形表达关联更新变化Id
        virtual RegenDataId GetOpeningGraphicsElementShapeRdId() const = 0;

        /// \brief 判断是否允许计算打洞相交图形
        /// 
        /// 设置是否允许计算打洞对象和被打洞对象相交的图形。
        /// \return true-允许计算打洞相交图形；false-不允许计算打洞相交图形
        virtual bool ShouldCalculateIntersectingGraphicsElementShape() const = 0;

        /// \brief 设置是否允许计算打洞相交图形
        ///
        /// \param vtrue true-允许计算打洞相交图形；false-不允许计算打洞相交图形
        /// \return true-设置成功；false-设置失败
        virtual bool SetShouldCalculateIntersectingGraphicsElementShape(bool value) = 0;

    public:
        /// \brief 设置该行为所属Element
        /// \param pOwnerElement 所属Element
        /// \return bool
        virtual bool SetOwnerElement(IElement* pOwnerElement) = 0;

        /// \brief 获得该行为所属的Element
        /// \return 所属的Element
        virtual IElement* GetOwnerElement() = 0;

        /// \brief 获得该行为所属的Element
        /// \return 所属的Element
        virtual const IElement* GetOwnerElement() const = 0;
    };
}

